Implement VotingStreakMultiplier #129
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
secbajor
commented
Apr 25, 2025
RonTuretzky
requested changes
Apr 26, 2025
RonTuretzky
reviewed
Apr 28, 2025
RonTuretzky
reviewed
Apr 29, 2025
|
@bagelface @RonTuretzky with my latest commit here, the build is compiling without errors/warnings and the tests all pass. Can you advise on next steps? |
RonTuretzky
requested changes
May 8, 2025
|
@RonTuretzky @bagelface Can you advise now on next steps? |
RonTuretzky
requested changes
May 23, 2025
| function mint(address receiver) external payable virtual; | ||
| } | ||
|
|
||
| contract VotingStreakMultiplierTest is Test { |
There was a problem hiding this comment.
There is already a Voting multiplier testing section here , would probably be better to refactor this to extend that area
not gonna block this PR on that though tbh, thoughts @bagelface ?
Lets keep in mind this will all be refactored for breadkit anyways
There was a problem hiding this comment.
ok i moved them to the yd 5376053
Comment on lines
197
to
279
| function test_multiplier_increment_after_3_subsequent_cycles() public { | ||
| VotingStreakMultiplier multiplier = setUpVotingStreakMultiplier(); | ||
| address testAccount = setUpTestAccount(); | ||
| uint256 cycleIterator = 0; | ||
| setUpForCycle(yieldDistributor, cycleIterator); | ||
|
|
||
| // Initial multiplier should be 0 | ||
| assertEq(multiplier.getMultiplyingFactor(testAccount), 0); | ||
|
|
||
| castVote(testAccount); | ||
|
|
||
| // Verify multiplier was updated to multiplierIncrement | ||
| assertEq(multiplier.getMultiplyingFactor(testAccount), multiplier.multiplierIncrement()); | ||
| assertEq( | ||
| multiplier.validUntil(testAccount), | ||
| yieldDistributor.lastClaimedBlockNumber() + 2 * yieldDistributor.cycleLength() | ||
| ); | ||
|
|
||
| // Roll to the next cycle | ||
| cycleIterator++; | ||
| setUpForCycle(yieldDistributor, cycleIterator); | ||
|
|
||
| castVote(testAccount); | ||
|
|
||
| // Verify multiplier was updated to 2 * multiplierIncrement | ||
| assertEq(multiplier.getMultiplyingFactor(testAccount), 2 * multiplier.multiplierIncrement()); | ||
|
|
||
| // Roll to the next cycle | ||
| cycleIterator++; | ||
| setUpForCycle(yieldDistributor, cycleIterator); | ||
|
|
||
| castVote(testAccount); | ||
|
|
||
| // Verify multiplier was updated to 3 * multiplierIncrement | ||
| assertEq(multiplier.getMultiplyingFactor(testAccount), 3 * multiplier.multiplierIncrement()); | ||
| } | ||
|
|
||
| // when the account has voted in 4 subsequent cycles, the account's multiplier is equal to maxMultiplier | ||
| function test_multiplier_increment_after_4_subsequent_cycles() public { | ||
| VotingStreakMultiplier multiplier = setUpVotingStreakMultiplier(); | ||
| address testAccount = setUpTestAccount(); | ||
| uint256 cycleIterator = 0; | ||
| setUpForCycle(yieldDistributor, cycleIterator); | ||
|
|
||
| // Initial multiplier should be 0 | ||
| assertEq(multiplier.getMultiplyingFactor(testAccount), 0); | ||
|
|
||
| castVote(testAccount); | ||
|
|
||
| // Verify multiplier was updated to multiplierIncrement | ||
| assertEq(multiplier.getMultiplyingFactor(testAccount), multiplier.multiplierIncrement()); | ||
| assertEq( | ||
| multiplier.validUntil(testAccount), | ||
| yieldDistributor.lastClaimedBlockNumber() + 2 * yieldDistributor.cycleLength() | ||
| ); | ||
|
|
||
| // Roll to the next cycle | ||
| cycleIterator++; | ||
| setUpForCycle(yieldDistributor, cycleIterator); | ||
|
|
||
| castVote(testAccount); | ||
|
|
||
| // Verify multiplier was updated to 2 * multiplierIncrement | ||
| assertEq(multiplier.getMultiplyingFactor(testAccount), 2 * multiplier.multiplierIncrement()); | ||
|
|
||
| // Roll to the next cycle | ||
| cycleIterator++; | ||
| setUpForCycle(yieldDistributor, cycleIterator); | ||
|
|
||
| castVote(testAccount); | ||
|
|
||
| // Verify multiplier was updated to 3 * multiplierIncrement | ||
| assertEq(multiplier.getMultiplyingFactor(testAccount), 3 * multiplier.multiplierIncrement()); | ||
|
|
||
| // Roll to the next cycle | ||
| cycleIterator++; | ||
| setUpForCycle(yieldDistributor, cycleIterator); | ||
|
|
||
| castVote(testAccount); | ||
|
|
||
| // Verify multiplier does not exceed maxMultiplier * multiplierIncrement | ||
| assertEq(multiplier.getMultiplyingFactor(testAccount), MAX_MULTIPLIER * MULTIPLIER_INCREMENT); | ||
| } |
There was a problem hiding this comment.
These tests should be removed in favor of a fuzz test
You can reference the two tests here for how you can turn a vanilla test into a fuzz test
There was a problem hiding this comment.
oh thats neat! thanks for the tip.
replaced those tests with a fuzz test fe64fc6
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When a vote is cast (via the YieldDistributor), the VotingStreakMultiplier updates it's state variables tracking user's multiplier value and validity.
When this contract is deployed, the front end can call
getMultiplyingFactorfor the user's current multiplier.